<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>gui2py: Fichero Fuente gui/doc/ext/autosummary/generate.py</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="../../edit.gif"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">gui2py
   &#160;<span id="projectnumber">0.9.3</span>
   </div>
   <div id="projectbrief">Interfaz de desarrollo de aplicaciones graficas</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generado por Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Buscar');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="../../index.html"><span>Página&#160;principal</span></a></li>
      <li><a href="../../namespaces.html"><span>Paquetes</span></a></li>
      <li><a href="../../annotated.html"><span>Clases</span></a></li>
      <li class="current"><a href="../../files.html"><span>Archivos</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="../../search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Buscar" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="../../files.html"><span>Lista&#160;de&#160;archivos</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('d0/d2a/generate_8py_source.html','../../');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>Todo</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Clases</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Archivos</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Funciones</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Propiedades</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">generate.py</div>  </div>
</div><!--header-->
<div class="contents">
<a href="../../d0/d2a/generate_8py.html">Ir a la documentación de este archivo.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"><a class="line" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html">    1</a></span>&#160;<span class="comment"># -*- coding: utf-8 -*-</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="stringliteral">&quot;&quot;&quot;</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="stringliteral">    sphinx.ext.autosummary.generate</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="stringliteral">    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="stringliteral">    Usable as a library or script to generate automatic RST source files for</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="stringliteral">    items referred to in autosummary:: directives.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="stringliteral">    Each generated RST file contains a single auto*:: directive which</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="stringliteral">    extracts the docstring of the referred item.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="stringliteral">    Example Makefile rule::</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="stringliteral">       generate:</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="stringliteral">               sphinx-autogen -o source/generated source/*.rst</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="stringliteral">    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="stringliteral">    :license: BSD, see LICENSE for details.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="stringliteral">&quot;&quot;&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="keyword">import</span> os</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="keyword">import</span> re</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">import</span> sys</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="keyword">import</span> pydoc</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">import</span> optparse</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="keyword">import</span> inspect</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keyword">from</span> jinja2 <span class="keyword">import</span> FileSystemLoader, TemplateNotFound</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="keyword">from</span> jinja2.sandbox <span class="keyword">import</span> SandboxedEnvironment</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="keyword">from</span> sphinx <span class="keyword">import</span> package_dir</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="keyword">from</span> ..autosummary <span class="keyword">import</span> import_by_name, get_documenter</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">from</span> sphinx.jinja2glue <span class="keyword">import</span> BuiltinTemplateLoader</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="keyword">from</span> sphinx.util.osutil <span class="keyword">import</span> ensuredir</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="keyword">from</span> sphinx.util.inspect <span class="keyword">import</span> safe_getattr</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a3a02339012d7bec12dc24d5439637c9b">   37</a></span>&#160;<span class="keyword">def </span><a class="code" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a3a02339012d7bec12dc24d5439637c9b">main</a>(argv=sys.argv):</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    usage = <span class="stringliteral">&quot;&quot;&quot;%prog [OPTIONS] SOURCEFILE ...&quot;&quot;&quot;</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    p = optparse.OptionParser(usage.strip())</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    p.add_option(<span class="stringliteral">&quot;-o&quot;</span>, <span class="stringliteral">&quot;--output-dir&quot;</span>, action=<span class="stringliteral">&quot;store&quot;</span>, type=<span class="stringliteral">&quot;string&quot;</span>,</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;                 dest=<span class="stringliteral">&quot;output_dir&quot;</span>, default=<span class="keywordtype">None</span>,</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;                 help=<span class="stringliteral">&quot;Directory to place all output in&quot;</span>)</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    p.add_option(<span class="stringliteral">&quot;-s&quot;</span>, <span class="stringliteral">&quot;--suffix&quot;</span>, action=<span class="stringliteral">&quot;store&quot;</span>, type=<span class="stringliteral">&quot;string&quot;</span>,</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;                 dest=<span class="stringliteral">&quot;suffix&quot;</span>, default=<span class="stringliteral">&quot;rst&quot;</span>,</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;                 help=<span class="stringliteral">&quot;Default suffix for files (default: %default)&quot;</span>)</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    p.add_option(<span class="stringliteral">&quot;-t&quot;</span>, <span class="stringliteral">&quot;--templates&quot;</span>, action=<span class="stringliteral">&quot;store&quot;</span>, type=<span class="stringliteral">&quot;string&quot;</span>,</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;                 dest=<span class="stringliteral">&quot;templates&quot;</span>, default=<span class="keywordtype">None</span>,</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;                 help=<span class="stringliteral">&quot;Custom template directory (default: %default)&quot;</span>)</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    options, args = p.parse_args(argv[1:])</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    <span class="keywordflow">if</span> len(args) &lt; 1:</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;        p.error(<span class="stringliteral">&#39;no input files given&#39;</span>)</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <a class="code" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a17fba05e5123cfec51599724111de1ed">generate_autosummary_docs</a>(args, options.output_dir,</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;                              <span class="stringliteral">&quot;.&quot;</span> + options.suffix,</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;                              template_dir=options.templates)</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;</div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a8f93cf1882f91e6ba4c40f6e80370013">   58</a></span>&#160;<span class="keyword">def </span><a class="code" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a8f93cf1882f91e6ba4c40f6e80370013">_simple_info</a>(msg):</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    <span class="keywordflow">print</span> msg</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#ab134def6174aac580f19affbe730c9f3">   61</a></span>&#160;<span class="keyword">def </span><a class="code" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#ab134def6174aac580f19affbe730c9f3">_simple_warn</a>(msg):</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="keywordflow">print</span> &gt;&gt; sys.stderr, <span class="stringliteral">&#39;WARNING: &#39;</span> + msg</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"># -- Generating output ---------------------------------------------------------</span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="keyword">def </span><a class="code" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a17fba05e5123cfec51599724111de1ed">generate_autosummary_docs</a>(sources, output_dir=None, suffix=&#39;.rst&#39;,</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;                              warn=_simple_warn, info=_simple_info,</div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a17fba05e5123cfec51599724111de1ed">   69</a></span>&#160;                              base_path=<span class="keywordtype">None</span>, builder=<span class="keywordtype">None</span>, template_dir=<span class="keywordtype">None</span>):</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    showed_sources = list(sorted(sources))</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    <span class="keywordflow">if</span> len(showed_sources) &gt; 20:</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;        showed_sources = showed_sources[:10] + [<span class="stringliteral">&#39;...&#39;</span>] + showed_sources[-10:]</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    info(<span class="stringliteral">&#39;[autosummary] generating autosummary for: %s&#39;</span> %</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;         <span class="stringliteral">&#39;, &#39;</span>.join(showed_sources))</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    <span class="keywordflow">if</span> output_dir:</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;        info(<span class="stringliteral">&#39;[autosummary] writing to %s&#39;</span> % output_dir)</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <span class="keywordflow">if</span> base_path <span class="keywordflow">is</span> <span class="keywordflow">not</span> <span class="keywordtype">None</span>:</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;        sources = [os.path.join(base_path, filename) <span class="keywordflow">for</span> filename <span class="keywordflow">in</span> sources]</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    <span class="comment"># create our own templating environment</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    template_dirs = [os.path.join(package_dir, <span class="stringliteral">&#39;ext&#39;</span>,</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;                                  <span class="stringliteral">&#39;autosummary&#39;</span>, <span class="stringliteral">&#39;templates&#39;</span>)]</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    <span class="keywordflow">if</span> builder <span class="keywordflow">is</span> <span class="keywordflow">not</span> <span class="keywordtype">None</span>:</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;        <span class="comment"># allow the user to override the templates</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;        template_loader = BuiltinTemplateLoader()</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;        template_loader.init(builder, dirs=template_dirs)</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    <span class="keywordflow">else</span>:</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;        <span class="keywordflow">if</span> template_dir:</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;            template_dirs.insert(0, template_dir)</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;        template_loader = FileSystemLoader(template_dirs)</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    template_env = SandboxedEnvironment(loader=template_loader)</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    <span class="comment"># read</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;    items = <a class="code" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#adee378b29011934404d29eb08888e04b">find_autosummary_in_files</a>(sources)</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    <span class="comment"># remove possible duplicates</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;    items = dict([(item, <span class="keyword">True</span>) <span class="keywordflow">for</span> item <span class="keywordflow">in</span> items]).keys()</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;    <span class="comment"># keep track of new files</span></div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;    new_files = []</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;    <span class="comment"># write</span></div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;    <span class="keywordflow">for</span> name, path, template_name <span class="keywordflow">in</span> sorted(items):</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;        <span class="keywordflow">if</span> path <span class="keywordflow">is</span> <span class="keywordtype">None</span>:</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;            <span class="comment"># The corresponding autosummary:: directive did not have</span></div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;            <span class="comment"># a :toctree: option</span></div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;            <span class="keywordflow">continue</span></div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;        path = output_dir <span class="keywordflow">or</span> os.path.abspath(path)</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;        ensuredir(path)</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;        <span class="keywordflow">try</span>:</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;            name, obj, parent = <a class="code" href="../../d3/d80/namespaceext_1_1autosummary.html#a15888e1d18c1e327692693741e291708">import_by_name</a>(name)</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;        <span class="keywordflow">except</span> ImportError, e:</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;            warn(<span class="stringliteral">&#39;[autosummary] failed to import %r: %s&#39;</span> % (name, e))</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;            <span class="keywordflow">continue</span></div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;        fn = os.path.join(path, name + suffix)</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;        <span class="comment"># skip it if it exists</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;        <span class="keywordflow">if</span> os.path.isfile(fn):</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;            <span class="keywordflow">continue</span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;        new_files.append(fn)</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;        f = open(fn, <span class="stringliteral">&#39;w&#39;</span>)</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;</div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;        <span class="keywordflow">try</span>:</div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;            doc = <a class="code" href="../../d3/d80/namespaceext_1_1autosummary.html#ad35c09a2169d57a54689972da96f16de">get_documenter</a>(obj, parent)</div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;</div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;            <span class="keywordflow">if</span> template_name <span class="keywordflow">is</span> <span class="keywordflow">not</span> <span class="keywordtype">None</span>:</div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;                template = template_env.get_template(template_name)</div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;            <span class="keywordflow">else</span>:</div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;                <span class="keywordflow">try</span>:</div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;                    template = template_env.get_template(<span class="stringliteral">&#39;autosummary/%s.rst&#39;</span></div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;                                                         % doc.objtype)</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;                <span class="keywordflow">except</span> TemplateNotFound:</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;                    template = template_env.get_template(<span class="stringliteral">&#39;autosummary/base.rst&#39;</span>)</div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;</div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;            <span class="keyword">def </span>get_members(obj, typ, include_public=[]):</div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;                items = []</div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;                <span class="keywordflow">for</span> name <span class="keywordflow">in</span> dir(obj):</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;</div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;                    <span class="keywordflow">if</span> sys.skip_member(name, obj): <span class="keywordflow">continue</span>                    </div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;                    <span class="keywordflow">if</span> typ <span class="keywordflow">in</span> [<span class="stringliteral">&#39;class&#39;</span>, <span class="stringliteral">&#39;function&#39;</span>]:</div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;                        c = getattr(obj, name)</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;                        <span class="keywordflow">if</span> inspect.isclass(c) <span class="keywordflow">or</span> inspect.isfunction(c):</div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;                            <span class="keywordflow">if</span> (c.__module__!=obj.__name__+<span class="stringliteral">&quot;.base&quot;</span> <span class="keywordflow">and</span></div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;                                c.__module__!=obj.__name__):</div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;                                    <span class="keywordflow">continue</span>       </div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;                    <span class="keywordflow">try</span>:</div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;                        documenter = <a class="code" href="../../d3/d80/namespaceext_1_1autosummary.html#ad35c09a2169d57a54689972da96f16de">get_documenter</a>(safe_getattr(obj, name), obj)</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;                    <span class="keywordflow">except</span> AttributeError:</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;                        <span class="keywordflow">continue</span></div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;                    <span class="keywordflow">if</span> documenter.objtype == typ:</div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;                        items.append(name)</div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;                public = [x <span class="keywordflow">for</span> x <span class="keywordflow">in</span> items</div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;                          <span class="keywordflow">if</span> x <span class="keywordflow">in</span> include_public <span class="keywordflow">or</span> <span class="keywordflow">not</span> x.startswith(<span class="stringliteral">&#39;_&#39;</span>)]</div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;                <span class="keywordflow">return</span> public, items</div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;</div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;</div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;            <span class="keyword">def </span>def_members(obj, typ, include_public=[]):</div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;                items = []</div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;                <span class="keywordflow">try</span>:</div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;                    obj_dict = safe_getattr(obj, <span class="stringliteral">&#39;__dict__&#39;</span>)</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;                <span class="keywordflow">except</span> AttributeError:</div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;                    <span class="keywordflow">return</span> []</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;                defined = obj_dict.keys()</div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;                defined.sort()</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;                <span class="keywordflow">for</span> name <span class="keywordflow">in</span> defined:</div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;                    <span class="keywordflow">if</span> sys.skip_member(name, obj): <span class="keywordflow">continue</span></div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;                    <span class="keywordflow">try</span>:</div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;                        documenter = <a class="code" href="../../d3/d80/namespaceext_1_1autosummary.html#ad35c09a2169d57a54689972da96f16de">get_documenter</a>(safe_getattr(obj, name), obj)</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;                    <span class="keywordflow">except</span> AttributeError:</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;                        <span class="keywordflow">continue</span></div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;                    <span class="keywordflow">if</span> documenter.objtype == typ:</div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;                        items.append(name)</div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;                public = [x <span class="keywordflow">for</span> x <span class="keywordflow">in</span> items</div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;                          <span class="keywordflow">if</span> x <span class="keywordflow">in</span> include_public <span class="keywordflow">or</span> <span class="keywordflow">not</span> x.startswith(<span class="stringliteral">&#39;_&#39;</span>)]</div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;                <span class="keywordflow">return</span> public</div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;</div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;            ns = {}</div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;</div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;            <span class="keywordflow">if</span> doc.objtype == <span class="stringliteral">&#39;module&#39;</span>:</div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;                ns[<span class="stringliteral">&#39;all_members&#39;</span>] = dir(obj)</div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;</div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;                ns[<span class="stringliteral">&#39;classes&#39;</span>], ns[<span class="stringliteral">&#39;all_classes&#39;</span>] = \</div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;                                 get_members(obj, <span class="stringliteral">&#39;class&#39;</span>)</div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;                ns[<span class="stringliteral">&#39;functions&#39;</span>], ns[<span class="stringliteral">&#39;all_functions&#39;</span>] = \</div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;                                   get_members(obj, <span class="stringliteral">&#39;function&#39;</span>)</div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;                ns[<span class="stringliteral">&#39;exceptions&#39;</span>], ns[<span class="stringliteral">&#39;all_exceptions&#39;</span>] = \</div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;                                   get_members(obj, <span class="stringliteral">&#39;exception&#39;</span>)</div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;                documented = ns[<span class="stringliteral">&#39;classes&#39;</span>]+ns[<span class="stringliteral">&#39;functions&#39;</span>]+ns[<span class="stringliteral">&#39;exceptions&#39;</span>]</div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;                </div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;                <span class="keywordflow">if</span> sys.all_submodules.has_key(obj.__name__):</div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;                    ns[<span class="stringliteral">&#39;submodules&#39;</span>] = sys.all_submodules[obj.__name__]</div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;                    documented += ns[<span class="stringliteral">&#39;submodules&#39;</span>]</div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;</div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;                ns[<span class="stringliteral">&#39;members&#39;</span>] = ns[<span class="stringliteral">&#39;all_members&#39;</span>]</div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;                <span class="keywordflow">try</span>:</div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;                    obj_dict = safe_getattr(obj, <span class="stringliteral">&#39;__dict__&#39;</span>)</div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;                <span class="keywordflow">except</span> AttributeError:</div>
<div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;                    obj_dict = []</div>
<div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;</div>
<div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;                public = [x <span class="keywordflow">for</span> x <span class="keywordflow">in</span> obj_dict <span class="keywordflow">if</span> <span class="keywordflow">not</span> x.startswith(<span class="stringliteral">&#39;_&#39;</span>)]</div>
<div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;                <span class="keywordflow">for</span> item <span class="keywordflow">in</span> documented:</div>
<div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;                    <span class="keywordflow">if</span> item <span class="keywordflow">in</span> public:</div>
<div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;                        public.remove(item)</div>
<div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;</div>
<div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;                public.sort()</div>
<div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;                ns[<span class="stringliteral">&#39;members&#39;</span>] = public</div>
<div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;                ns[<span class="stringliteral">&#39;constants&#39;</span>] = [x <span class="keywordflow">for</span> x <span class="keywordflow">in</span> public</div>
<div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;                                   <span class="keywordflow">if</span> <span class="keywordflow">not</span> sys.skip_member(x, obj)]</div>
<div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;                </div>
<div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;            <span class="keywordflow">elif</span> doc.objtype == <span class="stringliteral">&#39;class&#39;</span>:</div>
<div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;                ns[<span class="stringliteral">&#39;members&#39;</span>] = dir(obj)</div>
<div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;                ns[<span class="stringliteral">&#39;events&#39;</span>], ns[<span class="stringliteral">&#39;all_events&#39;</span>] = \</div>
<div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;                                 get_members(obj, <span class="stringliteral">&#39;event&#39;</span>)</div>
<div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;                ns[<span class="stringliteral">&#39;methods&#39;</span>], ns[<span class="stringliteral">&#39;all_methods&#39;</span>] = \</div>
<div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;                                 get_members(obj, <span class="stringliteral">&#39;method&#39;</span>, [<span class="stringliteral">&#39;__init__&#39;</span>])</div>
<div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;                ns[<span class="stringliteral">&#39;attributes&#39;</span>], ns[<span class="stringliteral">&#39;all_attributes&#39;</span>] = \</div>
<div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;                                 get_members(obj, <span class="stringliteral">&#39;attribute&#39;</span>)</div>
<div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;</div>
<div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;                ns[<span class="stringliteral">&#39;def_events&#39;</span>] = def_members(obj, <span class="stringliteral">&#39;event&#39;</span>)</div>
<div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;                ns[<span class="stringliteral">&#39;def_methods&#39;</span>] = def_members(obj, <span class="stringliteral">&#39;method&#39;</span>, [<span class="stringliteral">&#39;__init__&#39;</span>])</div>
<div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;                ns[<span class="stringliteral">&#39;def_attributes&#39;</span>] = def_members(obj, <span class="stringliteral">&#39;attribute&#39;</span>)</div>
<div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;</div>
<div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;                ns[<span class="stringliteral">&#39;inherited&#39;</span>] = []</div>
<div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;                <span class="keywordflow">for</span> t <span class="keywordflow">in</span> [<span class="stringliteral">&#39;events&#39;</span>, <span class="stringliteral">&#39;methods&#39;</span>, <span class="stringliteral">&#39;attributes&#39;</span>]:</div>
<div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;                    key = <span class="stringliteral">&#39;inh_&#39;</span> + t</div>
<div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;                    ns[key]=[]</div>
<div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;                    <span class="keywordflow">for</span> item <span class="keywordflow">in</span> ns[t]:</div>
<div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;                        <span class="keywordflow">if</span> <span class="keywordflow">not</span> item <span class="keywordflow">in</span> ns[<span class="stringliteral">&#39;def_&#39;</span> + t]:</div>
<div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;                            ns[<span class="stringliteral">&#39;inherited&#39;</span>].append(item)</div>
<div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;                            ns[key].append(item)</div>
<div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;</div>
<div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;</div>
<div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;            parts = name.split(<span class="stringliteral">&#39;.&#39;</span>)</div>
<div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;            <span class="keywordflow">if</span> doc.objtype <span class="keywordflow">in</span> (<span class="stringliteral">&#39;method&#39;</span>, <span class="stringliteral">&#39;attribute&#39;</span>):</div>
<div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;                mod_name = <span class="stringliteral">&#39;.&#39;</span>.join(parts[:-2])</div>
<div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;                cls_name = parts[-2]</div>
<div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;                obj_name = <span class="stringliteral">&#39;.&#39;</span>.join(parts[-2:])</div>
<div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;                ns[<span class="stringliteral">&#39;class&#39;</span>] = cls_name</div>
<div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;            <span class="keywordflow">else</span>:</div>
<div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;                mod_name, obj_name = <span class="stringliteral">&#39;.&#39;</span>.join(parts[:-1]), parts[-1]</div>
<div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;</div>
<div class="line"><a name="l00251"></a><span class="lineno">  251</span>&#160;            ns[<span class="stringliteral">&#39;fullname&#39;</span>] = name</div>
<div class="line"><a name="l00252"></a><span class="lineno">  252</span>&#160;            ns[<span class="stringliteral">&#39;module&#39;</span>] = mod_name</div>
<div class="line"><a name="l00253"></a><span class="lineno">  253</span>&#160;            ns[<span class="stringliteral">&#39;objname&#39;</span>] = obj_name</div>
<div class="line"><a name="l00254"></a><span class="lineno">  254</span>&#160;            ns[<span class="stringliteral">&#39;name&#39;</span>] = parts[-1]</div>
<div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;</div>
<div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;            ns[<span class="stringliteral">&#39;objtype&#39;</span>] = doc.objtype</div>
<div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;            ns[<span class="stringliteral">&#39;underline&#39;</span>] = len(name) * <span class="stringliteral">&#39;=&#39;</span></div>
<div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;</div>
<div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;            rendered = template.render(**ns)</div>
<div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160;            f.write(rendered)</div>
<div class="line"><a name="l00261"></a><span class="lineno">  261</span>&#160;        <span class="keywordflow">finally</span>:</div>
<div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;            f.close()</div>
<div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;</div>
<div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;    <span class="comment"># descend recursively to new files</span></div>
<div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;    <span class="keywordflow">if</span> new_files:</div>
<div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;        <a class="code" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a17fba05e5123cfec51599724111de1ed">generate_autosummary_docs</a>(new_files, output_dir=output_dir,</div>
<div class="line"><a name="l00267"></a><span class="lineno">  267</span>&#160;                                  suffix=suffix, warn=warn, info=info,</div>
<div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;                                  base_path=base_path, builder=builder,</div>
<div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;                                  template_dir=template_dir)</div>
<div class="line"><a name="l00270"></a><span class="lineno">  270</span>&#160;</div>
<div class="line"><a name="l00271"></a><span class="lineno">  271</span>&#160;</div>
<div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160;<span class="comment"># -- Finding documented entries in files ---------------------------------------</span></div>
<div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;</div>
<div class="line"><a name="l00274"></a><span class="lineno"><a class="line" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#adee378b29011934404d29eb08888e04b">  274</a></span>&#160;<span class="keyword">def </span><a class="code" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#adee378b29011934404d29eb08888e04b">find_autosummary_in_files</a>(filenames):</div>
<div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;    <span class="stringliteral">&quot;&quot;&quot;Find out what items are documented in source/*.rst.</span></div>
<div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00277"></a><span class="lineno">  277</span>&#160;<span class="stringliteral">    See `find_autosummary_in_lines`.</span></div>
<div class="line"><a name="l00278"></a><span class="lineno">  278</span>&#160;<span class="stringliteral">    &quot;&quot;&quot;</span></div>
<div class="line"><a name="l00279"></a><span class="lineno">  279</span>&#160;    documented = []</div>
<div class="line"><a name="l00280"></a><span class="lineno">  280</span>&#160;    <span class="keywordflow">for</span> filename <span class="keywordflow">in</span> filenames:</div>
<div class="line"><a name="l00281"></a><span class="lineno">  281</span>&#160;        f = open(filename, <span class="stringliteral">&#39;</span><span class="stringliteral">r&#39;)</span></div>
<div class="line"><a name="l00282"></a><span class="lineno">  282</span>&#160;<span class="stringliteral">        lines = f.read().splitlines()</span></div>
<div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;<span class="stringliteral">        documented.extend(<a class="code" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a5bf8e0b085b8617635b76bd5d138a03d">find_autosummary_in_lines</a>(lines, filename=filename))</span></div>
<div class="line"><a name="l00284"></a><span class="lineno">  284</span>&#160;<span class="stringliteral">        f.close()</span></div>
<div class="line"><a name="l00285"></a><span class="lineno">  285</span>&#160;<span class="stringliteral">    </span><span class="keywordflow">return</span> documented</div>
<div class="line"><a name="l00286"></a><span class="lineno">  286</span>&#160;</div>
<div class="line"><a name="l00287"></a><span class="lineno"><a class="line" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#affc9fee20eaf997c51e0899836eb12b5">  287</a></span>&#160;<span class="keyword">def </span><a class="code" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#affc9fee20eaf997c51e0899836eb12b5">find_autosummary_in_docstring</a>(name, module=None, filename=None):</div>
<div class="line"><a name="l00288"></a><span class="lineno">  288</span>&#160;    <span class="stringliteral">&quot;&quot;&quot;Find out what items are documented in the given object&#39;s docstring.</span></div>
<div class="line"><a name="l00289"></a><span class="lineno">  289</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00290"></a><span class="lineno">  290</span>&#160;<span class="stringliteral">    See `find_autosummary_in_lines`.</span></div>
<div class="line"><a name="l00291"></a><span class="lineno">  291</span>&#160;<span class="stringliteral">    &quot;&quot;&quot;</span></div>
<div class="line"><a name="l00292"></a><span class="lineno">  292</span>&#160;    <span class="keywordflow">try</span>:</div>
<div class="line"><a name="l00293"></a><span class="lineno">  293</span>&#160;        real_name, obj, parent = <a class="code" href="../../d3/d80/namespaceext_1_1autosummary.html#a15888e1d18c1e327692693741e291708">import_by_name</a>(name)</div>
<div class="line"><a name="l00294"></a><span class="lineno">  294</span>&#160;        lines = pydoc.getdoc(obj).splitlines()</div>
<div class="line"><a name="l00295"></a><span class="lineno">  295</span>&#160;        <span class="keywordflow">return</span> <a class="code" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a5bf8e0b085b8617635b76bd5d138a03d">find_autosummary_in_lines</a>(lines, module=name, filename=filename)</div>
<div class="line"><a name="l00296"></a><span class="lineno">  296</span>&#160;    <span class="keywordflow">except</span> AttributeError:</div>
<div class="line"><a name="l00297"></a><span class="lineno">  297</span>&#160;        <span class="keywordflow">pass</span></div>
<div class="line"><a name="l00298"></a><span class="lineno">  298</span>&#160;    <span class="keywordflow">except</span> ImportError, e:</div>
<div class="line"><a name="l00299"></a><span class="lineno">  299</span>&#160;        <span class="keywordflow">print</span> <span class="stringliteral">&quot;Failed to import &#39;%s&#39;: %s&quot;</span> % (name, e)</div>
<div class="line"><a name="l00300"></a><span class="lineno">  300</span>&#160;    <span class="keywordflow">return</span> []</div>
<div class="line"><a name="l00301"></a><span class="lineno">  301</span>&#160;</div>
<div class="line"><a name="l00302"></a><span class="lineno"><a class="line" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a5bf8e0b085b8617635b76bd5d138a03d">  302</a></span>&#160;<span class="keyword">def </span><a class="code" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a5bf8e0b085b8617635b76bd5d138a03d">find_autosummary_in_lines</a>(lines, module=None, filename=None):</div>
<div class="line"><a name="l00303"></a><span class="lineno">  303</span>&#160;    <span class="stringliteral">&quot;&quot;&quot;Find out what items appear in autosummary:: directives in the</span></div>
<div class="line"><a name="l00304"></a><span class="lineno">  304</span>&#160;<span class="stringliteral">    given lines.</span></div>
<div class="line"><a name="l00305"></a><span class="lineno">  305</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00306"></a><span class="lineno">  306</span>&#160;<span class="stringliteral">    Returns a list of (name, toctree, template) where *name* is a name</span></div>
<div class="line"><a name="l00307"></a><span class="lineno">  307</span>&#160;<span class="stringliteral">    of an object and *toctree* the :toctree: path of the corresponding</span></div>
<div class="line"><a name="l00308"></a><span class="lineno">  308</span>&#160;<span class="stringliteral">    autosummary directive (relative to the root of the file name), and</span></div>
<div class="line"><a name="l00309"></a><span class="lineno">  309</span>&#160;<span class="stringliteral">    *template* the value of the :template: option. *toctree* and</span></div>
<div class="line"><a name="l00310"></a><span class="lineno">  310</span>&#160;<span class="stringliteral">    *template* ``None`` if the directive does not have the</span></div>
<div class="line"><a name="l00311"></a><span class="lineno">  311</span>&#160;<span class="stringliteral">    corresponding options set.</span></div>
<div class="line"><a name="l00312"></a><span class="lineno">  312</span>&#160;<span class="stringliteral">    &quot;&quot;&quot;</span></div>
<div class="line"><a name="l00313"></a><span class="lineno">  313</span>&#160;    autosummary_re = re.compile(<span class="stringliteral">r&#39;^(\s*)\.\.\s+autosummary::\s*&#39;</span>)</div>
<div class="line"><a name="l00314"></a><span class="lineno">  314</span>&#160;    automodule_re = re.compile(</div>
<div class="line"><a name="l00315"></a><span class="lineno">  315</span>&#160;        <span class="stringliteral">r&#39;^\s*\.\.\s+automodule::\s*([A-Za-z0-9_.]+)\s*$&#39;</span>)</div>
<div class="line"><a name="l00316"></a><span class="lineno">  316</span>&#160;    module_re = re.compile(</div>
<div class="line"><a name="l00317"></a><span class="lineno">  317</span>&#160;        <span class="stringliteral">r&#39;^\s*\.\.\s+(current)?module::\s*([a-zA-Z0-9_.]+)\s*$&#39;</span>)</div>
<div class="line"><a name="l00318"></a><span class="lineno">  318</span>&#160;    autosummary_item_re = re.compile(<span class="stringliteral">r&#39;^\s+(~?[_a-zA-Z][a-zA-Z0-9_.]*)\s*.*?&#39;</span>)</div>
<div class="line"><a name="l00319"></a><span class="lineno">  319</span>&#160;    toctree_arg_re = re.compile(<span class="stringliteral">r&#39;^\s+:toctree:\s*(.*?)\s*$&#39;</span>)</div>
<div class="line"><a name="l00320"></a><span class="lineno">  320</span>&#160;    template_arg_re = re.compile(<span class="stringliteral">r&#39;^\s+:template:\s*(.*?)\s*$&#39;</span>)</div>
<div class="line"><a name="l00321"></a><span class="lineno">  321</span>&#160;</div>
<div class="line"><a name="l00322"></a><span class="lineno">  322</span>&#160;    documented = []</div>
<div class="line"><a name="l00323"></a><span class="lineno">  323</span>&#160;</div>
<div class="line"><a name="l00324"></a><span class="lineno">  324</span>&#160;    toctree = <span class="keywordtype">None</span></div>
<div class="line"><a name="l00325"></a><span class="lineno">  325</span>&#160;    template = <span class="keywordtype">None</span></div>
<div class="line"><a name="l00326"></a><span class="lineno">  326</span>&#160;    current_module = module</div>
<div class="line"><a name="l00327"></a><span class="lineno">  327</span>&#160;    in_autosummary = <span class="keyword">False</span></div>
<div class="line"><a name="l00328"></a><span class="lineno">  328</span>&#160;    base_indent = <span class="stringliteral">&quot;&quot;</span></div>
<div class="line"><a name="l00329"></a><span class="lineno">  329</span>&#160;</div>
<div class="line"><a name="l00330"></a><span class="lineno">  330</span>&#160;    <span class="keywordflow">for</span> line <span class="keywordflow">in</span> lines:</div>
<div class="line"><a name="l00331"></a><span class="lineno">  331</span>&#160;        <span class="keywordflow">if</span> in_autosummary:</div>
<div class="line"><a name="l00332"></a><span class="lineno">  332</span>&#160;            m = toctree_arg_re.match(line)</div>
<div class="line"><a name="l00333"></a><span class="lineno">  333</span>&#160;            <span class="keywordflow">if</span> m:</div>
<div class="line"><a name="l00334"></a><span class="lineno">  334</span>&#160;                toctree = m.group(1)</div>
<div class="line"><a name="l00335"></a><span class="lineno">  335</span>&#160;                <span class="keywordflow">if</span> filename:</div>
<div class="line"><a name="l00336"></a><span class="lineno">  336</span>&#160;                    toctree = os.path.join(os.path.dirname(filename),</div>
<div class="line"><a name="l00337"></a><span class="lineno">  337</span>&#160;                                           toctree)</div>
<div class="line"><a name="l00338"></a><span class="lineno">  338</span>&#160;                <span class="keywordflow">continue</span></div>
<div class="line"><a name="l00339"></a><span class="lineno">  339</span>&#160;</div>
<div class="line"><a name="l00340"></a><span class="lineno">  340</span>&#160;            m = template_arg_re.match(line)</div>
<div class="line"><a name="l00341"></a><span class="lineno">  341</span>&#160;            <span class="keywordflow">if</span> m:</div>
<div class="line"><a name="l00342"></a><span class="lineno">  342</span>&#160;                template = m.group(1).strip()</div>
<div class="line"><a name="l00343"></a><span class="lineno">  343</span>&#160;                <span class="keywordflow">continue</span></div>
<div class="line"><a name="l00344"></a><span class="lineno">  344</span>&#160;</div>
<div class="line"><a name="l00345"></a><span class="lineno">  345</span>&#160;            <span class="keywordflow">if</span> line.strip().startswith(<span class="stringliteral">&#39;:&#39;</span>):</div>
<div class="line"><a name="l00346"></a><span class="lineno">  346</span>&#160;                <span class="keywordflow">continue</span> <span class="comment"># skip options</span></div>
<div class="line"><a name="l00347"></a><span class="lineno">  347</span>&#160;</div>
<div class="line"><a name="l00348"></a><span class="lineno">  348</span>&#160;            m = autosummary_item_re.match(line)</div>
<div class="line"><a name="l00349"></a><span class="lineno">  349</span>&#160;            <span class="keywordflow">if</span> m:</div>
<div class="line"><a name="l00350"></a><span class="lineno">  350</span>&#160;                name = m.group(1).strip()</div>
<div class="line"><a name="l00351"></a><span class="lineno">  351</span>&#160;                <span class="keywordflow">if</span> name.startswith(<span class="stringliteral">&#39;~&#39;</span>):</div>
<div class="line"><a name="l00352"></a><span class="lineno">  352</span>&#160;                    name = name[1:]</div>
<div class="line"><a name="l00353"></a><span class="lineno">  353</span>&#160;                <span class="keywordflow">if</span> current_module <span class="keywordflow">and</span> \</div>
<div class="line"><a name="l00354"></a><span class="lineno">  354</span>&#160;                       <span class="keywordflow">not</span> name.startswith(current_module + <span class="stringliteral">&#39;.&#39;</span>):</div>
<div class="line"><a name="l00355"></a><span class="lineno">  355</span>&#160;                    name = <span class="stringliteral">&quot;%s.%s&quot;</span> % (current_module, name)</div>
<div class="line"><a name="l00356"></a><span class="lineno">  356</span>&#160;                documented.append((name, toctree, template))</div>
<div class="line"><a name="l00357"></a><span class="lineno">  357</span>&#160;                <span class="keywordflow">continue</span></div>
<div class="line"><a name="l00358"></a><span class="lineno">  358</span>&#160;</div>
<div class="line"><a name="l00359"></a><span class="lineno">  359</span>&#160;            <span class="keywordflow">if</span> <span class="keywordflow">not</span> line.strip() <span class="keywordflow">or</span> line.startswith(base_indent + <span class="stringliteral">&quot; &quot;</span>):</div>
<div class="line"><a name="l00360"></a><span class="lineno">  360</span>&#160;                <span class="keywordflow">continue</span></div>
<div class="line"><a name="l00361"></a><span class="lineno">  361</span>&#160;</div>
<div class="line"><a name="l00362"></a><span class="lineno">  362</span>&#160;            in_autosummary = <span class="keyword">False</span></div>
<div class="line"><a name="l00363"></a><span class="lineno">  363</span>&#160;</div>
<div class="line"><a name="l00364"></a><span class="lineno">  364</span>&#160;        m = autosummary_re.match(line)</div>
<div class="line"><a name="l00365"></a><span class="lineno">  365</span>&#160;        <span class="keywordflow">if</span> m:</div>
<div class="line"><a name="l00366"></a><span class="lineno">  366</span>&#160;            in_autosummary = <span class="keyword">True</span></div>
<div class="line"><a name="l00367"></a><span class="lineno">  367</span>&#160;            base_indent = m.group(1)</div>
<div class="line"><a name="l00368"></a><span class="lineno">  368</span>&#160;            toctree = <span class="keywordtype">None</span></div>
<div class="line"><a name="l00369"></a><span class="lineno">  369</span>&#160;            template = <span class="keywordtype">None</span></div>
<div class="line"><a name="l00370"></a><span class="lineno">  370</span>&#160;            <span class="keywordflow">continue</span></div>
<div class="line"><a name="l00371"></a><span class="lineno">  371</span>&#160;</div>
<div class="line"><a name="l00372"></a><span class="lineno">  372</span>&#160;        m = automodule_re.search(line)</div>
<div class="line"><a name="l00373"></a><span class="lineno">  373</span>&#160;        <span class="keywordflow">if</span> m:</div>
<div class="line"><a name="l00374"></a><span class="lineno">  374</span>&#160;            current_module = m.group(1).strip()</div>
<div class="line"><a name="l00375"></a><span class="lineno">  375</span>&#160;            <span class="comment"># recurse into the automodule docstring</span></div>
<div class="line"><a name="l00376"></a><span class="lineno">  376</span>&#160;            documented.extend(<a class="code" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#affc9fee20eaf997c51e0899836eb12b5">find_autosummary_in_docstring</a>(</div>
<div class="line"><a name="l00377"></a><span class="lineno">  377</span>&#160;                current_module, filename=filename))</div>
<div class="line"><a name="l00378"></a><span class="lineno">  378</span>&#160;            <span class="keywordflow">continue</span></div>
<div class="line"><a name="l00379"></a><span class="lineno">  379</span>&#160;</div>
<div class="line"><a name="l00380"></a><span class="lineno">  380</span>&#160;        m = module_re.match(line)</div>
<div class="line"><a name="l00381"></a><span class="lineno">  381</span>&#160;        <span class="keywordflow">if</span> m:</div>
<div class="line"><a name="l00382"></a><span class="lineno">  382</span>&#160;            current_module = m.group(2)</div>
<div class="line"><a name="l00383"></a><span class="lineno">  383</span>&#160;            <span class="keywordflow">continue</span></div>
<div class="line"><a name="l00384"></a><span class="lineno">  384</span>&#160;</div>
<div class="line"><a name="l00385"></a><span class="lineno">  385</span>&#160;    <span class="keywordflow">return</span> documented</div>
<div class="line"><a name="l00386"></a><span class="lineno">  386</span>&#160;</div>
<div class="line"><a name="l00387"></a><span class="lineno">  387</span>&#160;</div>
<div class="line"><a name="l00388"></a><span class="lineno">  388</span>&#160;<span class="keywordflow">if</span> __name__ == <span class="stringliteral">&#39;__main__&#39;</span>:</div>
<div class="line"><a name="l00389"></a><span class="lineno">  389</span>&#160;    <a class="code" href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a3a02339012d7bec12dc24d5439637c9b">main</a>()</div>
<div class="ttc" id="namespaceext_1_1autosummary_1_1generate_html_a17fba05e5123cfec51599724111de1ed"><div class="ttname"><a href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a17fba05e5123cfec51599724111de1ed">ext.autosummary.generate.generate_autosummary_docs</a></div><div class="ttdeci">def generate_autosummary_docs</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d2a/generate_8py_source.html#l00069">generate.py:69</a></div></div>
<div class="ttc" id="namespaceext_1_1autosummary_1_1generate_html_adee378b29011934404d29eb08888e04b"><div class="ttname"><a href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#adee378b29011934404d29eb08888e04b">ext.autosummary.generate.find_autosummary_in_files</a></div><div class="ttdeci">def find_autosummary_in_files</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d2a/generate_8py_source.html#l00274">generate.py:274</a></div></div>
<div class="ttc" id="namespaceext_1_1autosummary_html_ad35c09a2169d57a54689972da96f16de"><div class="ttname"><a href="../../d3/d80/namespaceext_1_1autosummary.html#ad35c09a2169d57a54689972da96f16de">ext.autosummary.get_documenter</a></div><div class="ttdeci">def get_documenter</div><div class="ttdef"><b>Definition:</b> <a href="../../de/df9/gui_2doc_2ext_2autosummary_2____init_____8py_source.html#l00132">__init__.py:132</a></div></div>
<div class="ttc" id="namespaceext_1_1autosummary_1_1generate_html_a5bf8e0b085b8617635b76bd5d138a03d"><div class="ttname"><a href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a5bf8e0b085b8617635b76bd5d138a03d">ext.autosummary.generate.find_autosummary_in_lines</a></div><div class="ttdeci">def find_autosummary_in_lines</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d2a/generate_8py_source.html#l00302">generate.py:302</a></div></div>
<div class="ttc" id="namespaceext_1_1autosummary_1_1generate_html_ab134def6174aac580f19affbe730c9f3"><div class="ttname"><a href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#ab134def6174aac580f19affbe730c9f3">ext.autosummary.generate._simple_warn</a></div><div class="ttdeci">def _simple_warn</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d2a/generate_8py_source.html#l00061">generate.py:61</a></div></div>
<div class="ttc" id="namespaceext_1_1autosummary_html_a15888e1d18c1e327692693741e291708"><div class="ttname"><a href="../../d3/d80/namespaceext_1_1autosummary.html#a15888e1d18c1e327692693741e291708">ext.autosummary.import_by_name</a></div><div class="ttdeci">def import_by_name</div><div class="ttdef"><b>Definition:</b> <a href="../../de/df9/gui_2doc_2ext_2autosummary_2____init_____8py_source.html#l00422">__init__.py:422</a></div></div>
<div class="ttc" id="namespaceext_1_1autosummary_1_1generate_html_a3a02339012d7bec12dc24d5439637c9b"><div class="ttname"><a href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a3a02339012d7bec12dc24d5439637c9b">ext.autosummary.generate.main</a></div><div class="ttdeci">def main</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d2a/generate_8py_source.html#l00037">generate.py:37</a></div></div>
<div class="ttc" id="namespaceext_1_1autosummary_1_1generate_html_a8f93cf1882f91e6ba4c40f6e80370013"><div class="ttname"><a href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#a8f93cf1882f91e6ba4c40f6e80370013">ext.autosummary.generate._simple_info</a></div><div class="ttdeci">def _simple_info</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d2a/generate_8py_source.html#l00058">generate.py:58</a></div></div>
<div class="ttc" id="namespaceext_1_1autosummary_1_1generate_html_affc9fee20eaf997c51e0899836eb12b5"><div class="ttname"><a href="../../df/db0/namespaceext_1_1autosummary_1_1generate.html#affc9fee20eaf997c51e0899836eb12b5">ext.autosummary.generate.find_autosummary_in_docstring</a></div><div class="ttdeci">def find_autosummary_in_docstring</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d2a/generate_8py_source.html#l00287">generate.py:287</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="../../dir_be831313eee9167e67543a36aa74e60d.html">gui</a></li><li class="navelem"><a class="el" href="../../dir_6b2f4cb30d7d08448890535a3509ff9b.html">doc</a></li><li class="navelem"><a class="el" href="../../dir_888b0cd96a72baa4be367983e2560747.html">ext</a></li><li class="navelem"><a class="el" href="../../dir_5c019086e928440b727450cfccf5814e.html">autosummary</a></li><li class="navelem"><a class="el" href="../../d0/d2a/generate_8py.html">generate.py</a></li>
    <li class="footer">Generado el Domingo, 7 de Diciembre de 2014 18:59:47 para gui2py por
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
